/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Initial Developer of the Original Code is
*   Nick Kreeger
* Portions created by the Initial Developer are Copyright (C) 2006-2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*   Nick Kreeger <nick.kreeger@park.edu>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */

#import <Cocoa/Cocoa.h>

@class MailboxesDataSource;
class nsIMsgFolder;
class CHMailboxFolderListener;

extern NSString* const kMailboxDidAddSubfolder;

/**
 * This class should *really* be called MessageFolder.
 */
@interface MailboxItem : NSObject
{
  MailboxItem*    mParent;
  NSMutableArray* mChildren;
  NSImage*        mIcon;
  NSString*       mName;
  NSString*       mAccountKey;
  BOOL            mIsRootFolder;
  BOOL            mIsStartingUp;
  
  nsIMsgFolder*            mRepMsgFolder;     // weak ref
  MailboxesDataSource*     mDataSourceOwner;  // weak ref, it owns us
  CHMailboxFolderListener* mMailboxFolderListener;
}

-(id)initWithMsgFolder:(nsIMsgFolder*)aMsgFolder isRootFolder:(BOOL)inIsRootFolder;

-(MailboxItem*)childAtIndex:(int)inIndex;
-(void)addChild:(MailboxItem*)inChild;
-(int)numberOfChildren;
-(void)removeAllChildren;
-(NSArray*)children;
-(BOOL)isGroup;
-(BOOL)isRootFolder;

-(BOOL)isIMAPFolder;
-(BOOL)isRootFolder;

/**
 * Find all the folders that are stored on the server (i.e. IMAP) that
 * have not been discovered. This request will prompt for authorization
 * if the session for this folder is not active.
 */
-(void)discoverAllFolders;

-(void)setParentMailbox:(MailboxItem*)inParentMailbox;
-(void)setAccountKey:(NSString*)inAccountKey;
-(void)setDataSourceOwner:(MailboxesDataSource*)aOwner;
-(void)updateFolder;

/**
 * Returns the name of the mailbox, plus the number of unread messages
 * wrapped in parents.
 */
-(NSString*)displayName;

-(NSString*)name;
-(NSString*)accountKey;
-(NSImage*)icon;
-(MailboxItem*)parentMailbox;
-(nsIMsgFolder*)representedMsgFolder;

@end
